Nessa aula, abordamos a importância de manter uma boa prática de documentação no desenvolvimento e manutenção de um design system. Destacamos que, assim como é comum lançar um aplicativo com um release note, é crucial documentar todas as mudanças em um design system para garantir sua organização e longevidade. Pontos importantes da aula incluem:
- Revisão do Design System: Antes de adicionar qualquer atualização, é essencial revisar todas as páginas do design system para garantir que não há elementos soltos que possam comprometer a qualidade do sistema. Utilizamos o atalho Shift + 2 no Figma para fazer um zoom out e visualizar todo o conteúdo do canvas, facilitando a identificação e remoção de elementos desnecessários.
- Criação de um Changelog: Enfatizamos a importância de criar um log de mudanças logo após a página de boas-vindas do design system. Esse log deve ser atualizado com cada nova versão lançada, incluindo a data do release, uma descrição das mudanças, correções de bugs e informações sobre atualizações futuras.
- Estrutura do Changelog: Mostramos como estruturar o Change Log, incluindo a data, a versão do release, uma descrição das novidades e correções, e uma nota final incentivando o envolvimento com o design system. Também discutimos a possibilidade de adicionar informações sobre a equipe responsável pelo design system.
- Versionamento: Discutimos a importância de definir um sistema de versionamento para o design system, diferenciando entre patches (mudanças pequenas), minor releases (novas variantes ou correções que afetam o sistema de forma mais significativa) e major releases (atualizações grandes que podem incluir mudanças drásticas).
- Comunicação de Mudanças: Ressaltamos a necessidade de comunicar claramente as mudanças feitas no design system, especialmente se elas tiverem um impacto significativo nos designs existentes. Isso inclui a documentação adequada e avisos sobre mudanças importantes.
- Preparação para Publicação: Por fim, mencionamos que na próxima aula vamos finalizar a revisão, especialmente nas variáveis e propriedades dos componentes, para então publicar o design system.